GetWarehouseToUse (Method)

Description

Gets the system configured warehouse to use. Introduced in 2023.1

Request (GetWarehouseToUseSoapIn)

The request body is of type GetWarehouseToUse.

Request Body Parameters

Name	Description	Data Type
ClientCode	For internal use only.	xml:string
SessionToken	For internal use only.	xml:string
Item_ID	The identifier for the Item.	xml:int

Example

The following example shows how to perform the web operation in CyberStore.

Javascript

// Example: Get the warehouse to use for Item with ID 579

MakeAJAXCall("Fulfillment.GetWarehouseToUse", {
    Item_ID: 579
}, console.log)

200 Response (GetWarehouseToUseSoapOut)

The response body is of type GetWarehouseToUseResponse.

Response Body Parameters

Name	Description	Data Type
GetWarehouseToUseResult	A string value containing a JSON object. // Example 1: Returning no specified warehouse to use. { "Data": { "WarehouseToUse": "" }, "Result": { "Success": true, "Message": "No specific warehouse to use was returned.", "ElapsedTime": "47 ms" } }	xml:string

Name

Description

Data Type

GetWarehouseToUseResult

A string value containing a JSON object.

// Example 1: Returning no specified warehouse to use.

{
    "Data": {
        "WarehouseToUse": ""
    },
    "Result": {
        "Success": true,
        "Message": "No specific warehouse to use was returned.",
        "ElapsedTime": "47 ms"
    }
}

xml:string